[5/N] Add get_option/set_option APIs #11758

cccclai · 2025-06-17T16:12:49Z

Stack from ghstack (oldest at bottom):

Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map}

Differential Revision: D76825663

Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/) [ghstack-poisoned]

pytorch-bot · 2025-06-17T16:12:53Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/11758

📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❌ 2 New Failures, 2 Unrelated Failures

As of commit cfb760b with merge base 608a745 ():

NEW FAILURES - The following jobs have failed:

Lint / lintrunner / linux-job (gh)
>>> Lint for runtime/backend/options_map.h:
pull / unittest-buck / macos / macos-job (gh)
runtime/backend/test/backend_options_map_test.cpp:294:30: error: no viable conversion from 'Span<const BackendOption>' to 'Span<BackendOption>'

FLAKY - The following jobs failed but were likely due to flakiness present on trunk:

pull / test-custom-ops-linux / linux-job (gh) (detected as infra flaky with no log or failing log classifier)
pull / unittest-buck / linux / linux-job (gh) (detected as infra flaky with no log or failing log classifier)

This comment was automatically generated by Dr. CI and updates every 15 minutes.

Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/) ghstack-source-id: 290994800 Pull Request resolved: #11758

facebook-github-bot · 2025-06-17T16:13:33Z

This pull request was exported from Phabricator. Differential Revision: D76825663

github-actions · 2025-06-17T16:13:35Z

This PR needs a `release notes:` label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/) Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663) [ghstack-poisoned]

Pull Request resolved: #11758 ghstack-source-id: 290994800 Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/)

facebook-github-bot · 2025-06-17T18:23:46Z

This pull request was exported from Phabricator. Differential Revision: D76825663

Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/) Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663) [ghstack-poisoned]

Pull Request resolved: #11758 ghstack-source-id: 290994800 Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/)

facebook-github-bot · 2025-06-18T05:54:43Z

This pull request was exported from Phabricator. Differential Revision: D76825663

Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/) Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663) [ghstack-poisoned]

Pull Request resolved: #11758 ghstack-source-id: 290994800 Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/)

facebook-github-bot · 2025-06-18T06:06:06Z

This pull request was exported from Phabricator. Differential Revision: D76825663

Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/) Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663) [ghstack-poisoned]

Pull Request resolved: #11758 ghstack-source-id: 290994800 Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/)

facebook-github-bot · 2025-06-23T05:08:12Z

This pull request was exported from Phabricator. Differential Revision: D76825663

Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/) Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663) [ghstack-poisoned]

Pull Request resolved: #11758 ghstack-source-id: 290994800 Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/)

facebook-github-bot · 2025-06-23T05:12:06Z

This pull request was exported from Phabricator. Differential Revision: D76825663

kimishpatel · 2025-06-23T15:53:30Z

runtime/backend/options_map.h

+ * @return Error::Ok on success, Error::NotFound if backend is not found, or
+ * other error codes on failure
+ */
+ Error get_option(


Suggested change

Error get_option(

Error get_options(

kimishpatel · 2025-06-23T15:54:24Z

runtime/backend/options_map.h

+* @return Error::Ok on success, or the first error encountered when processing
+* the entries
+*/
+Error get_option(


I dont think we need this. If users want something like that, they can implement it or we wait to see if users want options like that and introduce it later.

Do you mean get_option function or the get_option with backend option map?

with backend options map, is what i meant

kimishpatel

this looks good. My suggestion though is that not have backendOptionsMap and related functionality right now. Users can either make convenient functions for themselves or just use set_option(name, options) for the backends they care for. And maybe just wait and see if this is something users want as part of et

Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/) Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663) [ghstack-poisoned]

Pull Request resolved: #11758 ghstack-source-id: 290994800 Expose the API to set/get backend option. We can either pass in {backend_name, backend options} or {backend options map} Differential Revision: [D76825663](https://our.internmc.facebook.com/intern/diff/D76825663/)

facebook-github-bot · 2025-06-23T18:39:18Z

This pull request was exported from Phabricator. Differential Revision: D76825663

…s} only This PR only expose the set_option/get_option API via the pair {backend_name, backend_options}, without necessarily backend options map. The backend options map and it's corresponding API will be exposed to another PR Reference PR in #11758 which exposes the set_option/get_option with backendoptions map too Differential Revision: [D77190316](https://our.internmc.facebook.com/intern/diff/D77190316/) [ghstack-poisoned]

…s} only This PR only expose the set_option/get_option API via the pair {backend_name, backend_options}, without necessarily backend options map. The backend options map and it's corresponding API will be exposed to another PR Reference PR in #11758 which exposes the set_option/get_option with backendoptions map too Differential Revision: [D77190316](https://our.internmc.facebook.com/intern/diff/D77190316/) ghstack-source-id: 292211297 Pull Request resolved: #11865

…ackend_name, backend options} only" This PR only expose the set_option/get_option API via the pair {backend_name, backend_options}, without necessarily backend options map. The backend options map and it's corresponding API will be exposed to another PR Reference PR in #11758 which exposes the set_option/get_option with backendoptions map too Differential Revision: [D77190316](https://our.internmc.facebook.com/intern/diff/D77190316/) [ghstack-poisoned]

…kend options} only" This PR only expose the set_option/get_option API via the pair {backend_name, backend_options}, without necessarily backend options map. The backend options map and it's corresponding API will be exposed to another PR Reference PR in #11758 which exposes the set_option/get_option with backendoptions map too Differential Revision: [D77190316](https://our.internmc.facebook.com/intern/diff/D77190316/) [ghstack-poisoned]

…s} only Pull Request resolved: #11865 This PR only expose the set_option/get_option API via the pair {backend_name, backend_options}, without necessarily backend options map. The backend options map and it's corresponding API will be exposed to another PR Reference PR in #11758 which exposes the set_option/get_option with backendoptions map too ghstack-source-id: 292211297 Differential Revision: [D77190316](https://our.internmc.facebook.com/intern/diff/D77190316/)